<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\request;

interface RequestCookiesHolder
{
	/**
	 * @param  string $name
	 * @return bool
	 */
	function hasCookie($name);
	
	/**
	 * @param  string $name
	 * @return string
	 * @throws OutOfRangeException
	 */
	function getCookie($name);
	
	/**
	 * @return array<string,string>
	 */
	function getCookies();
	
	/**
	 * @param  string $name
	 * @param  string $value
	 * @return RequestCookiesHolder
	 */
	function setCookie($name, $value);
	
	/**
	 * @param  array<string,string> $cookies
	 * @return RequestCookiesHolder
	 */
	function setCookies(array $cookies);
	
	/**
	 * @param  string $name
	 * @return RequestCookiesHolder
	 * @throws OutOfRangeException
	 */
	function removeCookie($name);
	
	/**
	 * @return RequestCookiesHolder
	 */
	function clearCookies();
	
	/**
	 * @param  RequestCookiesHolder $cookiesHolder
	 * @return RequestCookiesHolder
	 */
	function mergeCookies(RequestCookiesHolder $cookiesHolder);
}